Skip to content

Conversation

gaurav-nelson
Copy link
Contributor

For https://issues.redhat.com/browse/ROX-29787

Added documentation for the new explainability feature.

Cherrypick in rhacs-docs-4.8.

Preview:

@gaurav-nelson gaurav-nelson added RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.8 labels Jun 23, 2025
@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 23, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jun 23, 2025

@gaurav-nelson gaurav-nelson added the peer-review-needed Signifies that the peer review team needs to review this PR label Jun 23, 2025
@gaurav-nelson gaurav-nelson removed the peer-review-needed Signifies that the peer review team needs to review this PR label Jun 23, 2025
Copy link

@adisos adisos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding comments for updating examples text and with links to actual YAML configurations.

@gaurav-nelson gaurav-nelson force-pushed the ROX-25000-np-guard-explainability branch from bc60026 to 8d264c0 Compare June 25, 2025 06:39
@gaurav-nelson gaurav-nelson added the peer-review-needed Signifies that the peer review team needs to review this PR label Jun 25, 2025
@gaurav-nelson gaurav-nelson requested a review from adisos June 25, 2025 06:44
Comment on lines +16 to +18
|`--explain`
|Enhance the analysis of permitted connectivity with explanations per denied/allowed connection; supported only for txt output format.

Copy link
Contributor Author

@gaurav-nelson gaurav-nelson Jun 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: For peer review, please ignore this change. It is the actual output from the CLI tool.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question about this change:
why can't I see this update in the link for the table options here?

Also, why in this link the --exposure option exists, but not in the table of this changed file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @adisos this was an older file which we don't use anywhere. I've updated the correct file n my recent commit to fix it.

Copy link

@adisos adisos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, added one more question.

Comment on lines +16 to +18
|`--explain`
|Enhance the analysis of permitted connectivity with explanations per denied/allowed connection; supported only for txt output format.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question about this change:
why can't I see this update in the link for the table options here?

Also, why in this link the --exposure option exists, but not in the table of this changed file?

@agantony agantony added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jun 26, 2025
@gaurav-nelson gaurav-nelson force-pushed the ROX-25000-np-guard-explainability branch from 8d264c0 to 0698656 Compare June 26, 2025 11:44
Copy link
Contributor

@agantony agantony left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Highlighted a few issues; overall lgtm!

@agantony agantony added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jun 26, 2025
@gaurav-nelson gaurav-nelson force-pushed the ROX-25000-np-guard-explainability branch from 0698656 to d0c39aa Compare June 27, 2025 00:32
@gaurav-nelson gaurav-nelson force-pushed the ROX-25000-np-guard-explainability branch from d0c39aa to 52f8459 Compare June 27, 2025 00:33
@openshift-ci
Copy link

openshift-ci bot commented Jun 27, 2025

@gaurav-nelson: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@gaurav-nelson gaurav-nelson merged commit 6ecbc46 into openshift:rhacs-docs-main Jun 30, 2025
2 checks passed
@gaurav-nelson
Copy link
Contributor Author

/cherrypick rhacs-docs-4.8

@openshift-cherrypick-robot

@gaurav-nelson: new pull request created: #95412

In response to this:

/cherrypick rhacs-docs-4.8

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

peer-review-done Signifies that the peer review team has reviewed this PR RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.8 size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants